/*
 * Copyright 2017-2018 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.micronaut.http.server.netty.types;

import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.http.server.types.CustomizableResponseType;
import io.netty.channel.ChannelHandlerContext;

/**
 * A special type that allows writing data in Netty.
 *
 * @author James Kleeh
 * @since 1.0
 */
public interface NettyCustomizableResponseType extends CustomizableResponseType {

    /**
     * Write this instance to Netty.
     *
     * @param request  The request
     * @param response The response
     * @param context  The Netty {@link ChannelHandlerContext}
     */
    void write(HttpRequest<?> request, MutableHttpResponse<?> response, ChannelHandlerContext context);
}
